Skip to content

Fix docs link checks and enforce quality gates#115

Open
hauptmedia wants to merge 8 commits into
mainfrom
codex/docs-quality-gates
Open

Fix docs link checks and enforce quality gates#115
hauptmedia wants to merge 8 commits into
mainfrom
codex/docs-quality-gates

Conversation

@hauptmedia

@hauptmedia hauptmedia commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Summary

  • fix broken internal docs links and anchors reported by the Docusaurus build
  • register raw HTML anchors used in MDX tables so anchor validation can see them
  • enforce broken link, markdown link, and anchor checks as build failures
  • update stale Operaton Run download links to the Operaton GitHub releases
  • replace the stale internal FunctionMapper Javadoc URL with the Jakarta EL API reference
  • remove dead old Operaton BPMN/DMN modeling links and the stale 7.15 supported-environments URL
  • replace the dead operaton-consulting Business Rule Task example link with the maintained Operaton examples DMN decision example
  • replace selected absolute docs.operaton.org self-links and the malformed Operaton Run Spring integration href with local documentation links
  • keep the error event XML snippets and BPMN example spelling consistent
  • fix TypeScript 6 typecheck issues and quiet verbose BPMN build logging

Verification

  • curl -fsI -L --max-time 20 https://github.com/operaton/operaton/releases/latest
  • curl -fsI -L --max-time 20 https://jakarta.ee/specifications/expression-language/6.0/apidocs/jakarta.el/jakarta/el/functionmapper
  • curl checks showed the old operaton.org/bpmn/..., operaton.org/dmn/..., and docs.operaton.org/7.15/... URLs return 404
  • curl -I -L --max-time 20 https://github.com/operaton/operaton-consulting/tree/master/one-time-examples/order-confirmation-rules returns HTTP 404
  • curl -fsI -L --max-time 20 https://github.com/operaton/operaton-examples/tree/main/examples/dmn-decision returns HTTP 200
  • rg -n "downloads\\.camunda\\.cloud/release/operaton-bpm/run|org/operaton/bpm/engine/impl/javax/el/FunctionMapper\\.html|function mapper than" docs/documentation/installation/operaton-bpm-run.md docs/documentation/user-guide/operaton-bpm-run.md docs/documentation/user-guide/process-engine/decisions/bpmn-cmmn.md -S
  • rg -n "operaton\\.org/(bpmn|dmn|download)|docs\\.operaton\\.org/7\\.15" docs/documentation/introduction docs/documentation/reference/bpmn20 docs/documentation/user-guide/process-engine docs/documentation/user-guide/runtime-container-integration -S has no remaining matches for the updated areas
  • rg -n "operaton-consulting|DMN decision example|operaton-examples/tree/main/examples/dmn-decision" docs/documentation/reference/bpmn20/tasks/business-rule-task.md -S confirms the dead link is gone and the maintained example link is present
  • rg -n "docs\\.operaton\\.org/(docs/)?(documentation|docs/documentation|get-started)" docs/documentation/user-guide/security.md docs/documentation/reference/forms/embedded-forms/controls/bpmn-buttons.md docs/documentation/reference/deployment-descriptors/tags/process-engine.mdx docs/documentation/webapps/cockpit/extend/plugins.md docs/documentation/user-guide/spring-boot-integration/configuration.mdx docs/documentation/user-guide/operaton-bpm-run.md docs/documentation/user-guide/testing/index.md -S returns no matches
  • rg -n "ERROR-OCCURED|ERROR-OCCURRED" docs/documentation/reference/bpmn20/events/error-events.md docs/documentation/reference/bpmn20/events/bpmn/event-error.bpmn -S confirms the corrected example code appears consistently and the misspelling is gone
  • rg -n 'href="\.\.user-guide/spring-framework-integration/deployment"|href="\./spring-framework-integration/deployment\.md"' docs/documentation/user-guide/operaton-bpm-run.md -S confirms the malformed href is gone and the local Spring Framework deployment link is present
  • git diff --check
  • npm run typecheck
  • npm run build succeeds without Docusaurus broken-link or broken-anchor warnings


## Installation Procedure
1. Download the pre-packed distribution of [Operaton here](tbd).
1. Download the pre-packed distribution of [Operaton Run](https://downloads.camunda.cloud/release/operaton-bpm/run/).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wrong link

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in the current branch: this now points to the Operaton GitHub releases latest page (https://github.com/operaton/operaton/releases/latest) instead of the old Camunda downloads URL.


It is possible to add own functions which can be used inside JUEL expressions.
Therefore a new [FunctionMapper](org/operaton/bpm/engine/impl/javax/el/FunctionMapper.html) has to be implemented. The function mapper than
Therefore a new [FunctionMapper](https://docs.operaton.org/reference/latest/javadoc/org/operaton/bpm/engine/impl/javax/el/FunctionMapper.html) has to be implemented. The function mapper than

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Broken link. Is it actually now jakarta.el.FunctionMapper ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in the current branch: this now uses jakarta.el.FunctionMapper and links to the Jakarta Expression Language API reference.

@hauptmedia hauptmedia force-pushed the codex/docs-quality-gates branch from 42fa66d to 11222b5 Compare June 17, 2026 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants